API for configuring and manipulating NB IoT 6 Click driver. More...

Topics
	NB IoT 6 Device Settings
	Settings for registers of NB IoT 6 Click driver.
	NB IoT 6 MikroBUS Map
	MikroBUS pin mapping of NB IoT 6 Click driver.

Functions
void	nbiot6_cfg_setup (nbiot6_cfg_t *cfg)
	NB IoT 6 configuration object setup function.
err_t	nbiot6_init (nbiot6_t ctx, nbiot6_cfg_t cfg)
	NB IoT 6 initialization function.
err_t	nbiot6_generic_write (nbiot6_t ctx, uint8_t data_in, uint16_t len)
	NB IoT 6 data writing function.
err_t	nbiot6_generic_read (nbiot6_t ctx, uint8_t data_out, uint16_t len)
	NB IoT 6 data reading function.
void	nbiot6_set_pwr_pin (nbiot6_t *ctx, uint8_t state)
	NB IoT 6 set PWR pin function.
void	nbiot6_set_rst_pin (nbiot6_t *ctx, uint8_t state)
	NB IoT 6 set RST pin function.
void	nbiot6_set_wup_pin (nbiot6_t *ctx, uint8_t state)
	NB IoT 6 set WUP pin function.
uint8_t	nbiot6_get_ring_pin (nbiot6_t *ctx)
	NB IoT 6 get RING pin function.
void	nbiot6_set_power_state (nbiot6_t *ctx, uint8_t state)
	NB IoT 6 set power state function.
void	nbiot6_cmd_run (nbiot6_t ctx, uint8_t cmd)
	NB IoT 6 cmd run function.
void	nbiot6_cmd_set (nbiot6_t ctx, uint8_t cmd, uint8_t *value)
	NB IoT 6 cmd set function.
void	nbiot6_cmd_get (nbiot6_t ctx, uint8_t cmd)
	NB IoT 6 cmd get function.
void	nbiot6_cmd_help (nbiot6_t ctx, uint8_t cmd)
	NB IoT 6 cmd help function.
void	nbiot6_set_sim_apn (nbiot6_t ctx, uint8_t sim_apn)
	NB IoT 6 set sim card APN function.
void	nbiot6_send_sms_text (nbiot6_t ctx, uint8_t phone_number, uint8_t *sms_text)
	NB IoT 6 send SMS in text mode function.
err_t	nbiot6_send_sms_pdu (nbiot6_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	NB IoT 6 send SMS in PDU mode function.

Detailed Description

API for configuring and manipulating NB IoT 6 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ nbiot6_cfg_setup()

void nbiot6_cfg_setup ( nbiot6_cfg_t * cfg )

NB IoT 6 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See nbiot6_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ nbiot6_cmd_get()

void nbiot6_cmd_get	(	nbiot6_t *	ctx,
		uint8_t *	cmd )

NB IoT 6 cmd get function.

This function is used to get the value of a given command from the Click module.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns: None.

Note: None.

◆ nbiot6_cmd_help()

void nbiot6_cmd_help	(	nbiot6_t *	ctx,
		uint8_t *	cmd )

NB IoT 6 cmd help function.

This function provides a short description of the given command of the Click module.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns: None.

Note: None.

◆ nbiot6_cmd_run()

void nbiot6_cmd_run	(	nbiot6_t *	ctx,
		uint8_t *	cmd )

NB IoT 6 cmd run function.

This function sends a specified command to the Click module.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns: None.

Note: None.

◆ nbiot6_cmd_set()

void nbiot6_cmd_set	(	nbiot6_t *	ctx,
		uint8_t *	cmd,
		uint8_t *	value )

NB IoT 6 cmd set function.

This function sets a value to a specified command of the Click module.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	cmd	: Command string.
[in]	value	: Value string.

Returns: None.

Note: None.

◆ nbiot6_generic_read()

err_t nbiot6_generic_read	(	nbiot6_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

NB IoT 6 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

>0 - Number of data bytes read,
<=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot6_generic_write()

err_t nbiot6_generic_write	(	nbiot6_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

NB IoT 6 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot6_get_ring_pin()

uint8_t nbiot6_get_ring_pin ( nbiot6_t * ctx )

NB IoT 6 get RING pin function.

This function returns the ring indication (RING) pin logic state.

Parameters

[in] ctx : Click context object. See nbiot6_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ nbiot6_init()

err_t nbiot6_init	(	nbiot6_t *	ctx,
		nbiot6_cfg_t *	cfg )

NB IoT 6 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See nbiot6_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot6_send_sms_pdu()

err_t nbiot6_send_sms_pdu	(	nbiot6_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

NB IoT 6 send SMS in PDU mode function.

This function sends text message to a phone number in PDU mode.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	service_center_number	: SMSC of the SIM card.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot6_send_sms_text()

void nbiot6_send_sms_text	(	nbiot6_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

NB IoT 6 send SMS in text mode function.

This function sends text message to a phone number.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns: Nothing.

Note: None.

◆ nbiot6_set_power_state()

void nbiot6_set_power_state	(	nbiot6_t *	ctx,
		uint8_t	state )

NB IoT 6 set power state function.

This function sets a desired power state by toggling PWR, RST, and WUP pins with a specific time frame.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	state	: `0` - Power OFF, `1` - Power ON, `2` - Reset. `3` - Wake-up.

Returns: None.

Note: None.

◆ nbiot6_set_pwr_pin()

void nbiot6_set_pwr_pin	(	nbiot6_t *	ctx,
		uint8_t	state )

NB IoT 6 set PWR pin function.

This function sets the PWR (PWRKEY) pin logic state.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ nbiot6_set_rst_pin()

void nbiot6_set_rst_pin	(	nbiot6_t *	ctx,
		uint8_t	state )

NB IoT 6 set RST pin function.

This function sets the reset (RST) pin logic state.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ nbiot6_set_sim_apn()

void nbiot6_set_sim_apn	(	nbiot6_t *	ctx,
		uint8_t *	sim_apn )

NB IoT 6 set sim card APN function.

This function sets APN for sim card.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	sim_apn	: SIM card APN.

Returns: Nothing.

Note: None.

◆ nbiot6_set_wup_pin()

void nbiot6_set_wup_pin	(	nbiot6_t *	ctx,
		uint8_t	state )

NB IoT 6 set WUP pin function.

This function sets the wake up (WUP) pin logic state.

Parameters

[in]	ctx	: Click context object. See nbiot6_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ nbiot6_cfg_setup()

◆ nbiot6_cmd_get()

◆ nbiot6_cmd_help()

◆ nbiot6_cmd_run()

◆ nbiot6_cmd_set()

◆ nbiot6_generic_read()

◆ nbiot6_generic_write()

◆ nbiot6_get_ring_pin()

◆ nbiot6_init()

◆ nbiot6_send_sms_pdu()

◆ nbiot6_send_sms_text()

◆ nbiot6_set_power_state()

◆ nbiot6_set_pwr_pin()

◆ nbiot6_set_rst_pin()

◆ nbiot6_set_sim_apn()

◆ nbiot6_set_wup_pin()